home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 26
/
Cream of the Crop 26.iso
/
os2
/
tmail.zip
/
JFRQ103O.ZIP
/
JFRQ103P.RAR
/
JFREQ.DOC
< prev
next >
Wrap
Text File
|
1996-06-22
|
42KB
|
1,036 lines
- - - - -
J F R e q
- - - - -
External File Request Processor for FrontDoor, MainDoor,
Intermail or compatible mailers & Remote Access, Maximus, or any
BBS system based on a FILES.BBS structure
(C) 1994-96 Jordi Sese (Fidonet 2:343/116)
version 1.03
IMPORTANT
This program IS NOT, public domain. It is a Shareware Product. Please
read the document REGISTER.TXT to know about its conditions of use
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1 What is a File Request Processor? . . . . . . . . . . . . . . . . . 1
1.2 Features of JFReq 1.03 . . . . . . . . . . . . . . . . . . . . . . 1
1.3 Files in the distribution package . . . . . . . . . . . . . . . . . 2
2. Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1 UPGRADING from version 1.00 . . . . . . . . . . . . . . . . . . . . 3
2.2 UPGRADING from version 1.01 . . . . . . . . . . . . . . . . . . . . 3
2.3 UPGRADING from version 1.02 . . . . . . . . . . . . . . . . . . . . 3
2.4 General Installation Notes . . . . . . . . . . . . . . . . . . . . 3
2.5 Multiline systems . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.6 Environment Variables . . . . . . . . . . . . . . . . . . . . . . . 4
2.7 Mailer Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.7.1 MainDoor & MainDoor/2 . . . . . . . . . . . . . . . . . . . . . 5
2.7.2 FrontDoor 2.1x & 2.2x . . . . . . . . . . . . . . . . . . . . . 5
2.7.3 Intermail 2.27 . . . . . . . . . . . . . . . . . . . . . . . . 5
2.7.4 T-Mail mailer . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.7.5 SRIF capable mailer . . . . . . . . . . . . . . . . . . . . . . 6
2.8 The Setup Program (JFREQCFG.COM / JFRQCFGP.EXE) . . . . . . . . . . 6
2.8.1 Global Options . . . . . . . . . . . . . . . . . . . . . . . . 6
2.8.2 Time Settings: . . . . . . . . . . . . . . . . . . . . . . . . 7
2.8.3 Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.8.4 Mail Addresses . . . . . . . . . . . . . . . . . . . . . . . . 8
2.8.5 Template Editor . . . . . . . . . . . . . . . . . . . . . . . . 8
3. Other data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1 JFReq Command Line Parameters . . . . . . . . . . . . . . . . . . . 9
3.2 Tokens used in templates . . . . . . . . . . . . . . . . . . . . . 9
3.3 File Format for File & Directory listings and Alias file . . . . 11
3.3.1 file & directory listing: . . . . . . . . . . . . . . . . . . 11
3.3.2 ALIAS listing: . . . . . . . . . . . . . . . . . . . . . . . 11
3.3.3 On-line Programs and the alias file list . . . . . . . . . . 11
3.4 The nodelist compiler . . . . . . . . . . . . . . . . . . . . . . 12
3.5 The custom file index compiler . . . . . . . . . . . . . . . . . 13
3.6 Remote Access file index Speed-up . . . . . . . . . . . . . . . . 13
3.7 VIP Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.8 Statistical Reports . . . . . . . . . . . . . . . . . . . . . . . 14
3.9 Special Requests with Attached Messages . . . . . . . . . . . . . 15
3.10 TIC support . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.11 Editor Commands . . . . . . . . . . . . . . . . . . . . . . . . 15
3.12 Local Testing . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.13 Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.14 How to contact the author . . . . . . . . . . . . . . . . . . . 17
i
Chapter 1
Introduction
1.1 What is a File Request Processor?
Once upon a time, fidonet mailers searched a huge list of directories each
time another system requested a file, wasting a lot of time in sequential
searches. Now, from FrontDoor 2.1x, Intermail 2.27 and MainDoor and
MainDoor/2, you can execute an external utility to fast locate those
requested files and generate a personalised response message for the
asking system.
JFReq uses the existing file indexes of the BBS package (Maximus & Remote
Access are currently supported). This use of the automated index of your
BBS makes it possible to run this program with almost no maintenance at
all.
1.2 Features of JFReq 1.03
* Native versions for DOS and OS/2
* Multiline support
* Easy to use configuration program
* Mailers supported: FrontDoor (2.1x or better), MainDoor, InterMail
(2.27 or better), T-Mail or compatible mailers. Also supports SRIF
* BBS File Bases supported: Maximus (2.x, 3.x) and Remote Access (2.x)
(supported directly), and any system based on the FILES.BBS
structure.
* Directory listing and Alias file (with or without password)
* You can limit by day and/or session: Files, Kbytes to transmit, and
session lenght in minutes.
* Five types of session: Secure(with password), Listed & Unlisted
Systems, VIP Systems (fully customizable) and a Happy Hour period,
defining file lists and limits for each type of session separately.
* You can search for the existence of a specific node in a custom
nodelist index.
* Use of an equivalent user level for BBS File Base access
* Twit systems control definition, checking every piece of information
from the remote system
* Request Report and error messages are totally customizable, and
templates are selected automatically depending on the remote system's
address
* Additional messages are added when the remote system requests a
special file
* JFReq can send TIC files describing each of the files
1
Chapter 1. Introduction 2
* On-line program execution for registrations or remote processes
* File Password & Download Counter Support in Remote Access
* Automatic Download Counter Support for Maximus and FILES.BBS index.
* Free file/area support in all modes
* File Buffering for CD-ROMs and other critical drives
* Statistical reports as messages.
1.3 Files in the distribution package
100to101.COM Configuration upgrade program to 1.01
101to102.COM Configuration upgrade program to 1.02
102to103.COM Configuration upgrade program to 1.03
STCONV.COM Statistics upgrade program from 1.00 & 1.01. DOS version
STCONVP.EXE Statistics upgrade program from 1.00 & 1.01. OS/2 version
JFREQ.DOC JFReq users' manual. English version
JFREQ.ESP JFReq users' manual. Spanish version
JFREQP.EXE JFReq main executable. OS/2 version
JFRQCFGP.EXE JFReq configuration utility. OS/2
JFREQ.EXE JFReq main executable. DOS version
JFREQCFG.COM JFReq configuration utility. DOS
JFNCP.EXE Nodelist compiler. OS/2 version
JFNC.COM Nodelist compiler. DOS version
JFNC.CTL Nodelist control file for JFNC
JFFCP.EXE Secondary file index generator. OS/2
JFFC.COM Secondary file index generator. DOS
JFFC.CTL Secondary file index control file
JFSTATP.EXE Statistical Reports generator. OS/2
JFSTAT.COM Statistical Reports generator. DOS
LDATP.EXE JFREQ.DAT lister (OS/2)
LDAT.COM JFREQ.DAT lister (DOS)
DEFAULT.FRQ Default response template
*.FRQ Sample response templates
FNAMES.DAT Special requests control file
REGISTER.TXT Registration info, English version
REGISTRO.TXT Registration info, Spanish version
UADDRESS.DAT Twit systems (by address) control file
UMAILERS.DAT Twit systems (by string) control file
JFREQ.CFG Configuration file
JFREQ.DAT Data file (node information)
JFNC.NDX Nodelist index
JFFILES.IDX Custom File Index
JFAREA.DAT Custom Area Index
JFREQ.VIP VIP Systems specifications file
RAFILES.IDX RA speed-up index for JFREQ
JFRAFC.COM RA File Area Compiler for JFREQ (DOS)
JFRAFCP.EXE RA File Area Compiler for JFREQ (OS/2)
??#???.IDX Daily statistics file (index)
??#???.DAT Daily statistics file (data)
ACUM.IDX Main statistics index
ACUM_F.DAT File statistics
ACUM_N.DAT Node statistics
Chapter 2
Setup
2.1 UPGRADING from version 1.00
There is no direct upgrade from version 1.00 to 1.03. You should run
100to101.com to upgrade JFREQ.CFG to 1.01. Delete the file JFREQ.COM if
using DOS version. Then read and follow next sections to complete the
process.
2.2 UPGRADING from version 1.01
a) Run the utility called 101to102.com to update the file JFREQ.CFG to the
1.02 version.
b) Run the utility called STCONV.com (STCONVP.exe in OS/2) to upgrade your
statistics files to the new format.
c) Then read and follow next sections to complete the process.
2.3 UPGRADING from version 1.02
a) Unpack your 1.03 archive in the JFREQ directory, being careful not to
overwrite your 1.02 configuration files.
b) Run the utility called 102to103.com to update the file JFREQ.CFG to the
1.03 version.
c) If you are using a fast index for Remote Access, run JFRAFC (JFRAFCP in
OS/2) to update that index.
d) If you maintain a custom index run JFFC.com (JFFCP.exe in OS/2) to
update the custom index.
e) Run the configuration utility to check everything is fine.
2.4 General Installation Notes
JFReq runs on a 286 or better processor. SHARE or equivalent should be
installed if under DOS. Set an entry in your PATH pointing to the JFReq
main directory.
3
Chapter 2. Setup 4
Use the directory listings just for those files and / or directories which
are NOT in your BBS index. This search is quite slow compared to the
indexes, so use it only when necessary.
The custom index is intended for aditional file Doors or systems running a
BBS software other than RA or Max. For those later systems to work.
leave blank the 'BBS Path' field and select Remote Acces as 'BBS Type'.
In case you use RA or Max, this custom index is also checked if active.
In a single request session, JFReq can search an ALIAS file, a directory
listing, a BBS index and a custom index. Please try to make the search as
fast as possible, avoiding searching the same files more than once.
2.5 Multiline systems
Nothing has to be done in a multiline system, except having the
environment variables set correctly. JFReq keeps a LOG file for each
session (called JFREQ@.LOG, being @ the value of the TASK variable),
opening it with exclusive access to prevent configuration errors. All
other files are opened in shared mode.
2.6 Environment Variables
TASK Current task number. Needed for the support & temporary
files when you run a multiline system
JFREQ Points to the main JFReq directory. Needed when you
execute the program from a different directory.
examples:
SET TASK=1
SET JFREQ=C:\JFREQ
If you use MainDoor, make sure your MD environment variable is set.
2.7 Mailer Setup
IMPORTANT: Do not use very large paths in your Mailer configuration, for
Inbound & PKT directories, since the limitation of 128 characters in the
command line (due to the operating system limitations) might cause some
trouble in the execution.
IMPORTANT: Please write the parameters in the command line exactly as
shown here, except for the executable name (JFREQ for DOS, JFREQP.EXE for
OS/2), and its execution path (if needed).
Chapter 2. Setup 5
2.7.1 MainDoor & MainDoor/2
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ File Request │░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ Swap┌─── File Request ────┐░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│ Ento│ Ficheros │░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░└─────│ Límites │░░░░░░░░░░
░░░░░░░░░░░░░░░░░░ Copyright (c) 19│ Procesador │ppa. ░░░░░
┌──────────────────────────────── File Req - FRQP ──────────────────
│ Program jfreq /MD =F =R =T =X =B =H =D =W
│ Activo Si
│ Swapping Si
└───────────────────────────────────────────────────────────────────
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
Note: in some versions of MainDoor, the =W switch is not yet supported.
This won't affect the request, since this is an optional parameter.
2.7.2 FrontDoor 2.1x & 2.2x
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ ╔═══════════════════╗▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ ║ ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
▒╔═══════════════════════════════════════════════ Request processor
▒║
▒║ Program jfreq /FD =F =R =T =X =B =H =D =W░░░░░░░░░░░░░░░░░░░░░░░
▒║ Enabled Yes
▒║ Swapping Yes
▒║
▒╚══════════════════════════════════════════════════════════════════
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ Swapping ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
▒▒▒▒▒▒▒▒ Copyright ║ Protection ║mrighausen; All rights reserv
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║ Fax ║▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒╚══════════════════╝▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
2.7.3 Intermail 2.27
╔════════════════════════════════════════════════════ File requests
║
║ Mode Anyone can request
║ List C:\IM\SYSTEM\OKREQDIR.LST
║ Alias
║ Message
║ Max match 0
║ Max time 0
║ Max size 0
║ Min speed 300
║ Limited No
║ Start 00:00
║ End 00:00
║ Days -------A
║ External JFREQ /IM %A %F %X %B %M %D %O░░░░░░░░░░░░░░░░░░░░░░░░░░
║
╚═══════════════════════════════════════════════════════════════════
Chapter 2. Setup 6
2.7.4 T-Mail mailer
You must add a line very similar to the following to your T-Mail.Cfg file:
Process Freq JFREQ /TM <busy.t-m> *F <packets_dir>\T-$$-*T\RESPONSE.FRQ *H
being:
<busy.t-m> the path and filename of the Busy Flag file, as defined
in T-Mail.Ctl
<packets_dir> the directory for storing T-Mail packets, as defined in
T-Mail.Ctl
2.7.5 SRIF capable mailer
You just have to call JFReq with the parameter /SRIF, followed by the
information file created by your mailer:
JFREQ /SRIF <srif info file>
Take a look at your mailer's documentation and sustitute the bracketed
sentence for its corresponding macro. If your version of MainDoor
supports SRIF, then call JFReq as above but using /MDS instead of /SRIF.
2.8 The Setup Program (JFREQCFG.COM / JFRQCFGP.EXE)
The Setup Program is very easy to use and each option is explained at the
bottom of the screen when you are on it. The options marked with a <+>
sign are available only to registered users. If you are an unregistered
user, please read the file REGISTER.TXT to know how to obtain your
registration key.
2.8.1 Global Options
Allows you to change the values for the common options to all sessions:
BBS Type - currently Maximus and Remote access supported
BBS Path - main BBS directory
Use Custom Index - whether to use a secondary index created by
compiling FILES.BBS files. Use this option to
add support for CD-ROM doors not included in the
BBS index, or to use JFReq with another BBS
package (in this case, use the Remote Access
BBS type and leave blank the BBS Path field).
Download Counters - Type of download counter support. If you use
Remote Access, set to any of the types. If you
are using the custom index, choose the one you
use in your FILES.BBS files. The download counter
MUST exist for JFReq to update it.
Min. Baud Rate - minimum baud speed allowed
PKT Directory - directory for temporary and outbound packets
(normally the outbound directory or a RAM disc)
LOG Directory - directory for LOG files
Special Requests - edit the file that holds the filenames to attach
additional messages. The format is just <NAME>
Chapter 2. Setup 7
<full path msg file>. Messages can contain any of
the available tokens. If you wish to send an
additional message allways, use a point (.) as
filename.
Nodelist Lookup - enables / disables nodelist lookup in the custom
nodelist index
Nodelist Files - edits the list of nodelists to process when
executing JFNC/JFNCP, the nodelist compiler
Allow Outbound Req. - if you allow file requests from systems you are
calling
Buffered Drives - files from those discs will be copied to a TEMP
directory and deleted automatically after the
session
Buffering Path - temporary directory used to hold buffered files
Keep Statistics - keep track of the data for later statistical
reports. This option also controls Crash FREQ
detection.
Expand Wildcards - whether to send more than one file per request,
when it contains a wildcard character
CC to Sysop - If you want to receive a copy (as Netmail) of the
message(s) sent to each calling system.
Inbound Directory - Where to put the Carbon Copy .PKTs in order to be
processed by your mail processor.
2.8.2 Time Settings:
Start Time - global startup time for file requests
End Time - global ending time for file requests
Happy H. Start - startup time of the Happy Hour period
Happy H. End - ending time of the Happy Hour period
2.8.3 Limits
Used to fix the limitations for each set of sessions:
Listed / Unsecure - sessions with listed systems without password
Unlisted - sessions with unlisted systems and without a
session password
Passworded - password protected sessions. it does not mind
whether the system is listed or not
Happy Hour - unsecure sessions (systems without a session
password) within the Happy Hour period
VIP Systems - edit the specifications list for VIP Systems.
Consult the section VIP Systems to know about the
file format.
Unwanted Systems - two files containing strings to match with the
remote system's information. all systems with
matching strings will be considered twit systems
and they will be sent the BadTemplate portion of
the corresponding template
The options for each of these are the following:
Alias List File - edits a file containing alias file names and
their equivalences. its format is discussed later
Chapter 2. Setup 8
in this document
Directory List - edits a file containing a list of files and
directories (with or without a password), to
protect special directories or files that are not
in the BBS filebase. its format is discussed
later in this document
Level for BBS Access - BBS user level equivalent to the session type,
used to check the access to BBS file areas
Maximum Time - maximum time allowed in a single session,
calculed from the connection speed and the file
sizes
Maximum Size - maximum accumulated file size allowed in a session
Maximum Files - maximum number of files to be transmitted in a
single session
Max Time per Day - maximum time allowed per day
Max Size per Day - maximum size allowed per day
Max Files per Day - maximum number of files allowed per day
NOTES:
a) to disable a limit, enter a '0' value
b) if you leave blank the alias or directory list file, you will
disable that file checking in those sessions
2.8.4 Mail Addresses
Definition of the local system main address and up to seventeen secondary
mail addresses(AKAs)
2.8.5 Template Editor
Allows you to edit each of the templates from the setup program, selecting
first the file and then optionally editing:
Error Messages - edits each of the possible error responses
Template - edits the message to send in all allowed sessions
Bad Template - edits the message to send in case the system is
found to be a 'twit' one
Please read the section 'editor commands' to know how to use the internal
editor
Chapter 3
Other data
3.1 JFReq Command Line Parameters
Here is a description of the parameters passed in the command line. These
parameters are the mailer's, not JFREQ's. JFReq reads all of them
directly, to improve speed. Please enter the corresponding command line
exactly as stated for each operation mode
Operation Mode Selection:
/MD MainDoor Mode
/FD FrontDoor Mode
/IM InterMail Mode
/TM T-Mail Mode
/SRIF SRIF Mode
/MDS MainDoor in SRIF Mode
Mailer macros for FD/MD Mode
=F Remote System information file
=R File containing requested files
=T File to create containing files to be sent
=X SECURE/UNSECURE
=B Session speed in BPS
=H Minutes until next event not allowing FREQs
=D INBOUND/OUTBOUND (call direction)
=W LISTED/UNLISTED
Mailer macros for Intermail mode:
%A Remote system's mail address
%F File containing requested files
%X SECURE/UNSECURE/UNLISTED
%B Session Speed in BPS
%M Minutes until next event not allowing file requests
%D INBOUND/OUTBOUND (call direction)
%O Remote System's Sysop Name
3.2 Tokens used in templates
By using response templates, you can completely customize the resulting
message. Those files have the .FRQ extension, and they contain in its
main file name the clue to know what systems they will be sent to:
2#343.FRQ -> will be sent to all systems in zone 2, net 343
2#34@.FRQ -> will be sent to all systems in zone 2, and a net
number starting with 34 (341, 3421,...) that do
9
Chapter 3. Other data 10
not have another specific template.
2.FRQ -> will be sent to all systems in zone 2 that do
not have another specific template
DEFAULT.FRQ -> will be sent to all systems without a defined
template
This file MUST exist.
MYPOINTS.FRQ -> if exists, it will be sent to OUR points
If you create any files that match the names of the .FRQ files, but with a
.FRP extension, they will be used with systems that are Points. Thus, you
can have one template for Nodes, and another one for points.
To create a new template, just copy an existing template to the file name
corresponding to the set of addresses to be sent to.
All those files can be edited with any ASCII editor, but it is safer to
use the internal editor, since you can edit all the data separatedly.
Please follow the comments inside the files.
NOTES:
a) The automatic paragraph justification eliminates any extra
blanks, and sets a right margin of 75. All lines are left
justified.
b) Please do not forget to use the same Capitalization listed
here for any of the tokens
Token Value/Action
---------------------------------------------------------------------
@@BegJust Indicates the beginning of a justified paragraph
@@EndJust Indicates the end of a justified paragraph
@@FileDesc Here the listing of files and descriptions will be inserted
@@FrqSyst Remote system's name
@@FrqName Full name of the remote system's sysop
@@FrqAddr Mail Address of the remote system
@@FrqFrom Remote system's 'From' field
@@FrqPhon Remote system's telephone number
@@FrqSPWD Session Password used (blank if none)
@@FrqSerN Remote system's Mailer Serial Number
@@SesType Current Session Type (secure/unsecure/unlisted/happy hour)
@@PrgName Current program version
@@RegName Local user's name inside the key file
@@AKMatch Local mail address matching remote's
@@RegAKA<#> Local mail addresses. substitute <#> for the AKA number
@@MinBaud Minimum baud rate allowed
@@BegTime Global startup time for allowing file requests
@@EndTime Global ending time for allowing file requests
@@BegHapp Happy Hour startup time
@@EndHapp Happy Hour ending time
@@OkFiles Number of located files (not free) in this session
@@TKbytes Total Ks in located files (not free) in this session
@@TFreeKB Total Ks in located free files in this session
@@OkFFree Number of located free files in this session
@@CumCall Accumulated request calls of the remote system
@@CumFile Accumulated number of files requested by the remote system
@@CumSize Accumulated number of KBytes requested by remote
Chapter 3. Other data 11
@@CumTime Accumulated minutes by remote
@@DayFile Total files requested today by the remote system
@@DaySize Ks. requested today by the remote system
@@DayTime Minutes spent today by the remote system
@@MaxFile Maximum files allowed in this session
@@MaxSize Maximum size in Ks allowed in this session
@@MaxTime Maximum time in minutes allowed in this session
@@Ma<#>File Maximum number of files allowed in this type of session
@@Ma<#>Size Maximum number of Ks allowed in this session type
@@Ma<#>Time Maximum number of minutes allowed in this session type
@@Da<#>File Maximum files per day in this session type
@@Da<#>Size Maximum Ks per day in this session type
@@Da<#>Time Maximun minutes per day in this session type
Please substitute <#> for:
L - listed unsecure sessions
U - unlisted unsecure sessions
H - happy hour sessions
P - password protected sessions
A - active session type
3.3 File Format for File & Directory listings and Alias file
These files may be diferent for each type of session and must contain an
entry per line, with no blank lines and following this format:
3.3.1 file & directory listing:
to represent files:
<drive>:\<path>\<name>.<ext> [!<password>]
to represent directories:
<drive>:\<path> [!<password>]
example:
C:\FILES\SECRET.* !secure
3.3.2 ALIAS listing:
<alias>[$] [!<passwd>] <drive>:\<path>\<name>.<ext> [<drive>:\<path>\...]
examples:
THE_BETA !secure C:\FILES\SECRET.* C:\FILES\NOTES.ZIP
FILES$ C:\FILES\FILELIST.ZIP
Aliases ending with a dollar sign ('$') are considered free files. This
dollar sign is not considered a part of the alias name. (passwords in
both files are optional)
3.3.3 On-line Programs and the alias file list
If using OS/2, please don't miss the special section for OS/2 USERS below.
Please check in DOS systems memory limitations and use utilities that
require very few memory to run.
In order to execute an online program the user must request, just as
another file:
Chapter 3. Other data 12
%PRG=<program_alias> <program_parameters>
Being <program_alias> the magic name associated with the online program.
This magic should not be longer than 12 chars and be located in the
corresponding Alias file, ending with a '%' sign, to indicate its
nature, with this format:
<on-line_magic>% <type> <response_file> <program_command_line>
[<parameters>]
being:
<on-line_magic> the magic name
<type> any if the following:
PKT --> the response file is a standard PKT to be
sent directly to the remote user, and will
be deleted by the mailer after it is sent.
ATT --> the response file is to be attached
directly, and will be deleted by the mailer
after it is sent.
MSG --> the response file is a plain ASCII file,
which has to be converted and sent as a
message packet by JFReq.
<response_file> the file result of the on-line program execution
<prg_command_line> the command line of the on-line program to be
executed.
<parameters> (optional) extra parameters added to the %PRG
request will be added before the user-specified
parametters and will be passed to the on-line
program.
OS/2 USERS: If you have trouble running your on-line program under JFReqP
(low memory or system errors), or you want to use a .CMD file, you must
use HSTART (included in this package) with the /C and /WAIT parameters to
open a new OS/2 session. An example of its use would be:
LISTADOR% MSG c:\pkt\fichero.res HSTART /C /WAIT listador.cmd
3.4 The nodelist compiler
The executable file JFNC.COM (JFNCP.EXE for OS/2) builds up an index based
on the definitions in the file JFNC.CTL. With the resulting file
(JFNC.NDX), JFReq will know inmediately wether a system is listed in any
of the nodelists.
It is recomended that you use this function (Nodelist Lookup) only if your
mailer does not provide this information, since this nodelist checking
adds some time to the global process.
Remember to use the nodelist compiler each time you modify any of your
nodelists.
Chapter 3. Other data 13
The JFNC.CTL file is fully commented inside, so you should not have any
difficulty with that.
3.5 The custom file index compiler
In order to use the secondary index, you must build an ASCII file
(JFFC.CTL) using your favorite editor following this line format:
[!<password>] [#[$]<level>] <down. path> <files.bbs path> <desc. column>
[!<password>] (optional) password for all files in this area
[#[$]<user level>] (optional) equivalent user level for this file area in
numerical format. if you are using the Maximus mode, use this table:
0 - Disgrace If you use the Remote Access mode, just
1 - Limited use the verbatim you would use in RACONFIG
2 - Normal or JFREQCFG.
3 - Worthy
4 - Privil
5 - Favoured
6 - Extra
7 - Clerk
8 - AsstSysop
9 - SysOp
NOTE: File areas with a dollar sign ('$') before the user level are
considered Free by JFReq.
To update this index, execute JFFC(P) when necessary.
3.6 Remote Access file index Speed-up
You can use an special index with RA to decrease response times when
performing file searches. This index must be updated al least once a day
if you change any information in your BBS file index files. To use this
special index, just run the utility called JFRAFC.EXE to obtain the index
file RAFILES.IDX in your JFREQ directory.
The use of this index is automatic, so you have not to touch a thing in
your JFREQ configuration.
3.7 VIP Systems
JFREQ allows you to define specific limitations with your VIP systems,
based on the main address of the calling system. The specificatios to
allow this are in the file JFREQ.VIP:
Syst. Address BBS Lev. MaxTime MaxSize MaxFile DayTime DaySize DayFile
------------- -------- ------- ------- ------- ------- ------- -------
@2:343/116.* 300 60 5000 25 0 0 0
Chapter 3. Other data 14
2:343/129.0 300 60 5000 25 0 0 0
2:343/117.0 300 60 5000 25 0 0 0
'@' before an address means that the session must be 'secure' for this Vip
level to apply
Valid BBS user levels:
----------------------
RA mode:
use the same figures you use in JFREQCFG
Maximus mode:
0 - Disgrace
1 - Limited
2 - Normal
3 - Worthy
4 - Privil
5 - Favoured
6 - Extra
7 - Clerk
8 - AsstSysop
9 - SysOp
Please use FULL 4D addresses as shown above. Wildcards are allowed at any
place of the address.
0 in any field (except BBS level) means 'no limit'
3.8 Statistical Reports
JFSTAT(P) is the program you must execute in order to obtain an
statistical report of your system. These statistics are based on all
tasks of the system.
The syntax of this program can be:
a) report as a PKT file, to netmail or a message area:
JFSTAT(P) /PKT <to> <area> <inbound path> [days to report] [days to purge]
<to> stands for the name to address the message, using underscores for
spaces (e.g. Joe_Sysop).
<area> is NETMAIL for netmail message or the tag of the area you want to
have the report delivered.
<inbound path> is the path you use for receiving the inbound mail packets.
To be compatible with any message base, the output is done to a standard
PKT file, to be processed later on by your mail processor.
b) report to screen:
JFSTAT [days to report] [days to purge]
Chapter 3. Other data 15
[days to report] are the number of days you want to be reported about.
'0' or nothing means reporting everything available.
[days to purge] after reporting, any data before [days] will be deleted.
Eg. if you specify 4, any data older than four days from today will be
deleted. If you enter 0, all data will be deleted. This process only
affects the statistical data. Node information and Logs will remain
intact. If you do not provide a number, nothing will be deleted.
you can execute JFSTAT with no arguments, which will give you a global
statistical report (to screen) of all days kept.
3.9 Special Requests with Attached Messages
JFReq allows you to add specific messages to the mail packet if the remote
system requests a specific file. Thos messages can use all tokens
available. To activate this option, simply edit the file FNAMES.DAT from
the configuration program, by using the 'Special Requests' option in
Global options. In this file, you must specify a full filename (wildcards
allowed) to match, along with a file name corresponding to the message you
want to send to all systems requesting those files. By instance, if you
define the following line in FNAMES.DAT:
*.JPG c:\jfreq\gifjpg.msg
The file named gifjpg.msg will be added to the response packet (after
converting any tokens included), to all systems requesting files with a
JPG extension.
3.10 TIC support
JFReq can send a .TIC file along with each requested file. This .TIC file
is fully featured, so it should work with any fileecho processor. To
activate this feature, the requesting system should add to its request, as
if they were two more files:
%TIC=<area>
%PWD=<password>
Being <area> the fileecho to import the file, and <password> the one
defined in remote's file processor for our system.
3.11 Editor Commands
The JFReq Setup program includes a simple editor to help you in editing
the configuration files. Apart form the cursors and other well known
editing keys, those are other keys you can use inside the editor:
Ctrl+rig. arrow - places the cursor in the beginning of the next word
Ctrl+left arrow - places the cursor in the beginning of the previous word
Ctrl+end - deletes from the cursor to the end of line
Ctrl+home - deletes from the cursor to the beginning of the line
Chapter 3. Other data 16
Ctrl+backspace - deletes a entire line (you can undelete it with Alt+R)
Ctrl+PgDn - places the cursor at the end of the document
Ctrl+PgUp - places the cursor at the beginning of the document
Alt+S - copies the current line in memory
Alt+R - restores the latest copied or deleted line
Alt+X - ends the editing, saving the file
3.12 Local Testing
If you want to test your JFReq installation locally, here's a procedure
you can follow:
a) Create a plain ASCII file with similar contents to this one. This file
stores the information of the virtual remote caller:
----> begin srif.nfo <----
Sysop Juan Martin Perez
AKA 2:343/116.117@fidonet.org
Baud 28800
Time 1440
RequestList c:\jfreq\fich.req
ResponseList c:\jfreq\trans.req
RemoteStatus unprotected
SystemStatus listed
----> end srif.nfo <----
b) Create another ASCII file that matches the one entered in the
'RequestList' field above, which will contain the files to request:
----> begin fich.req <----
FILES
%TIC=TESTS
%PWD=MY_KEY
MYGIRL.GIF
MAX300?.*
----> end fich.req <----
c) Execute JFReq by using the following command line:
JFREQ /SRIF srif.nfo
d) If you followed the example, you will have in the JFReq directory a
file named TRANS.REQ, that will contain the full path to the files to be
sent, including a .PKT file and, if activated, the corresponding .TIC
files for the files requested. You can inspect those .PKT and TIC files
to trace the program execution. You can also check JFReq's LOG.
3.13 Credits
Many thanks to all my betatesters, and to their suggestions:
Ignacio Plasencia Rafael Gutiérrez
Rafael Suárez Fidel León
Chapter 3. Other data 17
Francisco Sedano Tony Saá
David Sáez Eduard Sánchez Biete
Tirs Abril Carlos Hermida
José Gonzalvo Jose Luis Hernández
Dave Carter
(and some more I sure forget...)
3.14 How to contact the author
Please send all your constructive comments on JFReq via electronic mail
to:
Jordi Sese,
BlackAdders' BBS: INT+34-3-2103303 (24Hr, V34, VFC, FAX)
Fidonet: 2:343/116
RedBBS: 757:101/25
Internet: shel@black.lonestar.es
or by slow surface mail:
Jordi Sese
C/ Sostres 31, Atico 1
08024 Barcelona
(Spain)
If you are a registered user, you can use these same media to ask those
questions to make your system work better with JFReq. If you have not
registered your program yet, please take a look at the file REGISTER.TXT
to know the conditions of use and how to become a registered user.
- End of JFReq.Doc -